Codecov Report

Attention: Patch coverage is 53.89507% with 580 lines in your changes missing coverage. Please review.

Project coverage is 70.58%. Comparing base (f80bcce) to head (9d64e1d).

✅ All tests successful. No failed tests found.

@@            Coverage Diff             @@
##             main     #285      +/-   ##
==========================================
- Coverage   72.17%   70.58%   -1.59%     
==========================================
  Files         117      128      +11     
  Lines        9936    10878     +942     
  Branches      597      633      +36     
==========================================
+ Hits         7171     7678     +507     
- Misses       2762     3193     +431     
- Partials        3        7       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🎉 The code now dehydrates to the client so it can render without JavaScript!

🎉 The code now dehydrates to the client so it run without JavaScript!

Wow 😵‍💫 and what about codetab

It rehydrates and runs with JS, but if you don't have JS, you can still view the docs. I used React's SSRing

@AugustinMauroy and I got search to finally work 🎉

@nodejs/nodejs-website @nodejs/web-infra ChangeHistory and SideBar aren't implemented yet, so this is still a draft, but it's ready for you to take a look, so feel free to review :-)

Rebasing to include #347

Using Rolldown appears to reduce compile time significantly... if I can get it to work 😅

What piece is not working? 👀

What piece is not working? 👀

(Oops, I accidentally deleted the comment)

It's causing a SyntaxError in some of the compiled code, which I'm investigating. It has to do with the string interpolation 🤔

If you look at https://api-docs-tooling-7fvr17mt4-openjs.vercel.app/, it doesn't generate most of the documentation.

🤦 I was using Math.random().toString(36).slice(2) to generate unique variable names, but forgot that that doesn't generate safe JavaScript variables (since it can start with a number). I needed to prefix it with _.

Based on my estimates, it should decrease the compile time, but we will see.

Based on my estimates, it should decrease the compile time, but we will see.

Is the latest version using Rolldown?

node bin/cli.mjs generate -t web -i "../node/doc/api/*.md" -o "./out" --index  52.77s user 15.80s system 202% cpu 33.882 total

Note that this is around 10s faster than the previous one. Are we still thinking on LightningCSS?

BTW, I still find impressive building all these react pages under 1 minute. They are huge long massive pages.

Note that this is around 10s faster than the previous one. Are we still thinking on LightningCSS?

The 10s improvement comes from LightningCSS + Rolldown, yes. Based on my testing, Rolldown is slightly faster than ESBuild, the LightningCSS is much faster than PostCSS, hence the improvement.

BTW, I still find impressive building all these react pages under 1 minute. They are huge long massive pages.

🎉 (My goal to make them even faster 🚀)

@nodejs/collaborators @nodejs/web-infra @nodejs/nodejs-website

If you could be so kind as to review https://api-docs-tooling.vercel.app/ and come up with a list of things that still need to be completed, it would be helpful. I know it's a bit tedious, but it'll help with the development significantly.

Note that we are aware of the following issues:

• The History component does not show HTML, see entry.changes aren't converted to HTML #326
• Unix Manual URLs are not linked, see fix(parser): transform man pages #349
• Some typed lists are not rendered as tables, see Lint Typed Lists #348
• "Copy to clipboard" notifications don't show, see feat(ui): move more Toast logic nodejs.org#7973
• The width of certain pages is larger than the viewport

Note that we are in the process of making the following improvements:

• Increasing the depth of the right-hand side ToC
• Adding a tooltip/expand to the DataTag, which explains what it refers to (@ovflowd, would you mind opening an issue in nodejs/nodejs.org?)
• A visualization of the extends keyword (which, I still need to design)
• Improving the UX of the Mobile Table Design, see Poor Table UX on Mobile nodejs.org#7656

Random thought which may have already been considered:

Given that we at this point have TypeScript support via type erasure, and this new design has a nice integrated format switcher, should we start allowing TypeScript examples to be added too?

Given that we at this point have TypeScript support via type erasure, and this new design has a nice integrated format switcher, should we start allowing TypeScript examples to be added too?

This generator supports TypeScript code snippets, yes.